home *** CD-ROM | disk | FTP | other *** search
/ Cobra Utilities for Doom & Doom II / Cobra Utilities For Doom & Doom II - Disc 2.iso / files / program / ted12 / ted.doc < prev    next >
Encoding:
Text File  |  1994-06-01  |  7.2 KB  |  226 lines
  1. DOOM ENDOOM Data Editor - version 1.2  May 1994
  2.  
  3.  
  4.  
  5. SUMMARY:
  6.  
  7. TED [/?] [data_file]
  8.  
  9. /?        :   Very brief help
  10. data_file :   Name of a file to load at startup
  11.  
  12.  
  13.  
  14. DESCRIPTION:
  15.  
  16.     TED is a full screen editor that allows editing of the ENDOOM data.
  17.     At the moment, TED does not allow direct editing of the IWAD or a
  18.     PWAD, although this may be added in the future (if I can figure out
  19.     from the DEU source how the WAD is organised :).
  20.  
  21.  
  22.  
  23. THE EDITOR'S COMMANDS:
  24.  
  25.     Once TED is run from the command line, an about box should appear.
  26.     Pressing any key will dismiss it and place you in the main editing
  27.     screen.  This is where all the editing of the ENDOOM data takes
  28.     place.
  29.  
  30.     Unless you loaded a file from the command line, the screen will
  31.     appear totally blank, except for the mouse cursor in the top left
  32.     corner of the screen.
  33.  
  34.     Most of the commands available in TED are provided by hot keys.
  35.     These keys are:
  36.  
  37.     ALT+H, F1  -   Help
  38.     ALT+S, F2  -   Save the screen to disk
  39.     ALT+L, F3  -   Load a screen from disk
  40.     ALT+X      -   Exit TED (no save is performed, so be sure to save
  41.                the file you are working on)
  42.     ALT+C      -   Clear the screen
  43.     CTRL+C     -   Change the current drawing colour
  44.     CTRL+K     -   Change characters to blinking
  45.     CTRL+B     -   Switch to box drawing mode
  46.     CTRL+L     -   Switch to line drawing mode (not yet implemented)
  47.     CTRL+T     -   Switch to text drawing mode
  48.     ESC        -   Cancel drawing (only while drawing)
  49.  
  50.  
  51.  
  52. EDITING AN IMAGE:
  53.  
  54.     TED has three basic editing modes - box drawing mode, text drawing
  55.     mode, and line drawing mode (not yet implemented).
  56.  
  57.     In box drawing mode, clicking and dragging the mouse will create a
  58.     box of the current colour.  Pressing ESC while the mouse button is
  59.     depressed will cancel the box.
  60.  
  61.     In text drawing mode, clicking will move the text cursor to the
  62.     position where the mouse button was clicked.  Typing in characters
  63.     will display those characters on the screen (surprise, surprise),
  64.     using the current colour.
  65.  
  66.     Note that it is possible to switch to line drawing mode, but it is
  67.     not implemented, so you can't do anything with it (except switch back
  68.     to the other modes).
  69.  
  70.  
  71.  
  72. SAVING AND LOADING IMAGES:
  73.  
  74.     Once you have finished your masterpiece, you can save it to disk
  75.     using the save file command (ALT+S, F2).  A dialog box will appear,
  76.     allowing you to enter the name of the file you wish to save into.
  77.     Hitting the ENTER key will save into the file listed in the textbox,
  78.     while hitting ESC will dismiss the dialog box without saving the
  79.     file at all.
  80.  
  81.     NOTE: If the file you save into already exists, its previous contents
  82.           will be lost - you have been warned!!  :)
  83.  
  84.  
  85.     Similarly, to load a previously saved file from disk, the load file
  86.     command (ALT+L, F3) can be used.  The dialog box works in exactly
  87.     the same way as the save file dialog box.
  88.  
  89.     Note that at this stage there is very minimal error checking for
  90.     the file routines.  If a file can't be saved or loaded, an error
  91.     dialog box will appear, but it doesn't attempt to identify the
  92.     problem.
  93.  
  94.  
  95.  
  96. INSERTING THE DATA INTO A WAD:
  97.  
  98.     To insert your masterpiece into a WAD, you must already have saved
  99.     it using the save command described above.  In addition, you will
  100.     need a WAD tool that allows you to insert raw data into the ENDOOM
  101.     directory entry in a WAD file.  I use DEU 5.2 for all my editing,
  102.     and it also handles insertion, so I use that.
  103.  
  104.  
  105.     The following example illustrates how the insertion is done
  106.     using DEU 5.1+:
  107.     (Other WAD tools are probably pretty similar.)
  108.  
  109.     Suppose your ENDOOM data file is called FRAGFEST.TED, and your PWAD
  110.     is called FRAGFEST.WAD:
  111.  
  112.  
  113.     STEP 1: Run DEU as follows:
  114.  
  115.          C:\GAMES\DOOM>deu
  116.          <DEU credits omitted>
  117.          [Press ? for Help]>
  118.  
  119.  
  120.  
  121.     STEP 2: Insert the raw data file into the ENDOOM directory entry:
  122.  
  123.          [Press ? for Help]>I FRAGFEST.TED ENDOOM
  124.  
  125.     This will create a PWAD called ENDOOM.WAD in your DEU directory.
  126.  
  127.  
  128.  
  129.     STEP 3: Read FRAGFEST.WAD and ENDOOM.WAD into DEU:
  130.  
  131.          [Press ? for Help]>R FRAGFEST.WAD
  132.              [Updating ExMx]
  133.          [Press ? for Help]>R ENDOOM.WAD
  134.              [Updating ENDOOM]
  135.  
  136.  
  137.  
  138.     STEP 4: Group the two together into a new PWAD called FF.WAD and
  139.         then exit DEU:
  140.  
  141.          [Press ? for Help]>G FF.WAD
  142.          [Press ? for Help]>Q
  143.  
  144.     This will create a PWAD called FF.WAD in your DEU directory that
  145.     contains not only your FRAGFEST.WAD level, but your customised
  146.     ENDOOM data as well.  Note that it is important that you name the
  147.     grouped WAD something other than your original name, as DEU might
  148.     screw it up (see PROBLEMS WHEN INSERTING USING DEU below).
  149.  
  150.  
  151.  
  152.     STEP 5: Run DOOM to test that it worked:
  153.  
  154.          C:\GAMES\DOOM>DOOM -FILE FF.WAD
  155.  
  156.  
  157.  
  158.  
  159. PROBLEMS WHEN INSERTING USING DEU:
  160.  
  161.     Quite a few people have had problems inserting ENDOOM data using DEU.
  162.     I have found that listing the currently open WADs (w command) in DEU
  163.     seems to close the ENDOOM.WAD file.  If you group after listing, you
  164.     won't have actually grouped in ENDOOM.WAD.
  165.  
  166.     Another problem I have had is that DEU occassionally scrambles either
  167.     the ENDOOM data or the level data.  If the level data is scrambled,
  168.     DOOM exits with an error as soon as you try to play the level.  If
  169.     the ENDOOM data is scrambled, the screen after exiting doom is full
  170.     of crap.  I'm not sure what causes this, but regrouping the
  171.     ENDOOM.WAD and the PWAD often fixes the problem.
  172.  
  173.     A third problem with DEU (and this applies to other data insertion as
  174.     well) is that if you load a PWAD with data other than just levels,
  175.     saving it loses that data.  To get around this, extract this extra
  176.     data before doing any editing of the PWAD, and recombine it when
  177.     you have finished editing (a pain in the rear end, but it's the best
  178.     solution I can think of).
  179.  
  180.  
  181.  
  182. UNEXPECTED FEATURES (BUGS!):
  183.  
  184.     TED will currently only work with a Microsoft compatible mouse
  185.     driver installed.  I could have written a keyboard emulator, but
  186.     with the widespread Windows invasion, I kind of assumed everyone
  187.     had a little rodent running around somewhere.
  188.  
  189.     It should run fine under Windows, although this has not been tested
  190.     at all.
  191.  
  192.     TED will only work on machines with colour video cards running in
  193.     a colour text mode, as it writes directly to screen memory (easy to
  194.     fix, but I'm just too busy).  If you are running DOOM in colour,
  195.     you should have no problems running TED.
  196.  
  197.     If a file save or load error occurs and the filename is long, the
  198.     error dialog box screws up (again, easy to fix).
  199.  
  200.     Other than these, I can't seem to find any other bugs, however if you
  201.     do find some, please send me descriptions of them and I'll dive back
  202.     into the code and try to work out what the hell I actually did!  :)
  203.  
  204.  
  205.  
  206. CODING HISTORY:
  207.  
  208.     TED is written entirely in Borland C++ v3.1 and comes to about 1500
  209.     lines of code (including the mouse routines and all my comments).
  210.  
  211.     TED 1.0 was written from scratch (minus the mouse routines) in just
  212.     under four hours, so it was pretty "quick and dirty".
  213.  
  214.     Another hours work fixed up a few little problems (like annoying key
  215.     combinations) to produce version 1.1.
  216.  
  217.     A couple more hours writing this document and restructuring the code
  218.     and voilà, version 1.2 was born.
  219.  
  220.  
  221.  
  222. COMMENTS/SUGGESTIONS:
  223.  
  224.     Peter Monks
  225.     pmonks@socs.uts.edu.au
  226.